Authorizations
A valid API key generated in Topsort's UI.
Query Parameters
Token for retrieving the next page.
Maximum number of campaigns to retrieve.
1 <= x <= 1000
The order dimension for the campaigns to be retrieved.
campaign_id
, name
, daily_budget
, impressions
, purchase_revenue
, roas
, cpc
, cpm
, ad_spend
, is_active
, ad_format
, start_date
, end_date
, created_at
The order direction for the campaigns to be retrieved.
asc
, desc
Start date for calculating metrics.
End date for calculating metrics.
A search string to filter the names of the campaigns by.
The campaign status to filter the campaigns by. Defaults to all statuses.
all
, active
, inactive
Response
Successful Response
Flag that indicates whether more results are available. true
indicates there is a next page of results. false
indicates this response contains the last page of results.
Pagination cursor. Provide this value as a next_page
query parameter in a new request to retrieve the next page of results.
1
"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="